Carbon


ControlUserPaneIdleProcPtr

Header: ControlDefinitions.h Carbon status: Supported

Performs idle processing.

typedef void(* ControlUserPaneIdleProcPtr) (
    ControlRef control
);

You would declare your function like this if you were to name it MyControlUserPaneIdleCallback:

void MyControlUserPaneIdleCallback (
    ControlRef control
);
Parameter descriptions
control

A handle to the control for which you wish to perform idle processing.

DISCUSSION

The Control Manager defines the data type ControlUserPaneIdleUPP to identify the universal procedure pointer for this application-defined function:

typedef UniversalProcPtr ControlUserPaneIdleUPP;

You typically use the NewControlUserPaneIdleProc macro like this:

ControlUserPaneIdleUPP myControlUserPaneIdleUPP;

myControlUserPaneIdleUPP = NewControlUserPaneIdleProc(MyControlUserPaneIdleCallback);

You typically use the CallControlUserPaneIdleProc macro like this:

CallControlUserPaneIdleProc(myControlUserPaneIdleUPP, control);

This function is called only if you’ve set the kControlWantsIdle feature bit on creation of the user pane control.

Once you have provided a user pane application-defined function, you can call the function SetControlData in order to associate your function with a control. User pane application-defined functions are identified to SetControlData by tag constants; for a description of the tag constants, see the“Control Manager Constants” section. For example, once you have created the function MyControlUserPaneIdleCallback, pass kControlUserPaneIdleProcTag in the tagName parameter of SetControlData.

VERSION NOTES

This function is available with Appearance Manager 1.0 and later.


© 2000 Apple Computer, Inc. (Last Updated 6/30/2000)